Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reformat/fine-tune docs #13897

Merged
merged 3 commits into from
Dec 9, 2020
Merged

Reformat/fine-tune docs #13897

merged 3 commits into from
Dec 9, 2020

Conversation

pat-s
Copy link
Member

@pat-s pat-s commented Dec 8, 2020 •
edited
Loading

This is a follow-up to #13890.

After introducing the new ToC shortcode in https://gitea.com/gitea/theme/commit/2949c6b8cdff80efef4ccde695baa7daede7d71b, the following changes to the docs are required:

  • In ever page, toc: false. Otherwise the toc will appear twice in the sidebar
  • Ever page needs to have one h1 and subsequent h2 or h3 headers

In addition I made the following changes:

  • Added a bold "Table of Contents" line before every instance of {{< toc >}}
  • Auto-format markdown (including tables)
  • Fine-tune headers
  • Add some more ToC instances
  • Fine-tune markdown highlighting blocks

@GiteaBot GiteaBot added the lgtm/need 1 This PR needs approval from one additional maintainer to be merged. label Dec 8, 2020
@6543 6543 added the type/docs This PR mainly updates/creates documentation label Dec 8, 2020
@6543 6543 added this to the 1.14.0 milestone Dec 8, 2020
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Dec 9, 2020
@codecov-io
Copy link

Codecov Report

Merging #13897 (6783dd8) into master (97ab820) will decrease coverage by 0.08%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #13897      +/-   ##
==========================================
- Coverage   42.23%   42.14%   -0.09%     
==========================================
  Files         709      709              
  Lines       77191    77191              
==========================================
- Hits        32598    32529      -69     
- Misses      39217    39310      +93     
+ Partials     5376     5352      -24
Impacted Files Coverage Δ
modules/util/timer.go 42.85% <0.00%> (-42.86%) ⬇️
modules/notification/ui/ui.go 84.72% <0.00%> (-8.34%) ⬇️
models/issue_comment.go 45.46% <0.00%> (-6.80%) ⬇️
modules/notification/mail/mail.go 33.33% <0.00%> (-5.75%) ⬇️
modules/git/commit.go 49.67% <0.00%> (-3.95%) ⬇️
modules/notification/base/null.go 74.28% <0.00%> (-2.86%) ⬇️
modules/notification/notification.go 83.92% <0.00%> (-2.68%) ⬇️
services/mailer/mail.go 60.21% <0.00%> (-1.08%) ⬇️
services/pull/pull.go 40.68% <0.00%> (-0.50%) ⬇️
models/error.go 38.98% <0.00%> (+0.48%) ⬆️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 97ab820...6783dd8. Read the comment docs.

@6543 6543 merged commit af79677 into go-gitea:master Dec 9, 2020
@pat-s pat-s deleted the docs-format branch December 9, 2020 07:11
@go-gitea go-gitea locked and limited conversation to collaborators Jan 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@lafriks lafriks lafriks approved these changes

@6543 6543 6543 approved these changes

Assignees
No one assigned
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. type/docs This PR mainly updates/creates documentation
Projects
None yet
Milestone
1.14.0
Development

Successfully merging this pull request may close these issues.
5 participants
@pat-s @codecov-io @lafriks @6543 @GiteaBot